Property Json Schema

In This Topic

Description

The Property object contains information on property types/the property to which a loan pertains.

Required Fields:

numberOfUnit
propertyType

To search for a specific property, use the Address object.

Overview

Property

The Property object contains information on property types/the property to which a loan pertains.

Required Fields:

numberOfUnit
propertyType

To search for a specific property, use the Address object.

address : Address

The address of a specific property.

censustract : string

Property ID in the national census data.

city : string

City where the property is located.

country : string

Country where the property is located.

county : string

County where the property is located.

This is used for countyFips. The best practice is to pass to alleviate issues when the same zip/state spans > 1 county (counties may have different loan limits).

Must pass state fips + county fips. Example, 25017 for Middlesex County, MA; 36103 for Suffolk, NY.

countyFips : string

CountyFips ID.

Populate this field if you are concerned that the state and zip area spans more than one county, in which case the API will only return the first county in the list.

countyName : string

Name of the county the property is located in.

defaultZipFipsComboOnMismatch : boolean

latitude : number

Property latitude.

longitude : number

Property longitude.

msa : string

province : string

The province where the property is located.

state : string

The state where the property is located.

Note: if only state and zip are passed, and the state and zip code area spans more than 1 county, the API will only return the first in the list. To avoid confusion, pass the countyFips.

stateFips : string

This field is DEFUNCT.

DO NOT USE.

street : string

The first line of the property street address.

Example: 10 Rose Court

streetCont : string

The second line of the property street address.

Example: Apt. C

zip : string

The property zip code.

Note: if only state and zip are passed, and the state and zip code area spans more than 1 county, the API will only return the first in the list. To avoid confusion, pass the countyFips.

zipExt : string

The four digit zip code area extension. The dash is not necessary.

Example: 2435

Do not enter in this format: -2435

attachmentType : string

A descriptor of a property's attachment type. Takes one of the values listed below.

Enum Values:

Attached
Detached
SemiDetached

bathrooms : number

The number of bathrooms in the property.

Value is stored as a double to account for half bathrooms.

Examples:

bedrooms : integer

The number of bedrooms in the property.

constructions : Array[string]

Accepts a string array.

creationDate : string

The date _ was created.

facts : Array[string]

Accepts a string array.

features : Array[string]

An array of features that the property contains. For example, to search for waterfront property with a wraparound porch, enter an array containing keywords of the features.

Example:

["waterfront", "wraparound porch"]

finishedSqFt : number

The area of the property, in square feet.

forSale : boolean

Indicates whether the property is for sale. Default is for sale, or True.

hoa : number

Accepts a double value.

id : ObjectId

ID of the Property object, stored as an ObjectID.

counter : integer

internal only

date : string

The current date.

internal only

machineIdentifier : integer

internal only

processIdentifier : integer

internal only

time : integer

internal only

timeSecond : integer

internal only

timestamp : integer

internal only

images : object

The property images, stored in a JSON object.

jsonImages : Array[JsPropertyFieldFile]

An array of JsPropertyFieldFile objects containing image data.

fileType : string

The file type, or file extension.

Example:

JPG
PNG
PDF
TIFF

filename : string

The name of the file.

key : string

objectId : string

The database ID for the image file, used to retrieve it from the database.

lastSoldDate : string

The last date on which this property was sold.

This field works in tandem with forSale, and should be populated if forSale is False.

Example: January 1, 2000

lastSoldPrice : number

The price at which the property was last sold.

links : Array[string]

Relevant links returned with each property.

lotSizeAcre : number

Property lot size in acres.

lotSizeSqFt : number

Property lot size in square feet.

mls : string

Accepts a string value.

modifiedByOverride : string

String that returns the date it was modified and who it was modified by.

numberOfUnit : integer

The number of units in the property. Default value is 1.

price : number

The price of the unit.

priceDate : string

The date on which the current price was set.

propertyDescription : string

A description of the property.

propertyTaxPercent : number

The property tax for the property, given as a percent out of 100.

Example: 3

propertyTaxYear : string

The year on which the current property tax was set. Returns a null string if there is has not been a property tax on this property.

propertyType : string

The type of property. Takes one of the values listed below. Default value is "SingleFamily".

Enum Values:

SingleFamily
Apartment
Condominium
Townhome
Townhouse
DetachedCondominium
HighRiseCondo
SiteCondo
ManufacturedHousingDoubleWide
ManufacturedHousingSingleWide
Cooperative
MultiFamily
ManufacturedHousing
ManufacturedHomeCondominium
ManufacturedHousingMultiWide
UnitDwelling_2_4

taxAssessment : number

The tax assessment for the property. Returns 0 if there has not been a tax assessment.

taxAssessmentYear : string

The year the property tax assessment was completed. Returns null string if tax assessment was never completed.

totalRooms : integer

The total number of rooms in the property.

yearBuilt : integer

The year the property was built.

Properties

Name	Description	Data Type
address	The address of a specific property.	Address
attachmentType	A descriptor of a property's attachment type. Takes one of the values listed below. Enum Values: Attached Detached SemiDetached	string
bathrooms	The number of bathrooms in the property. Value is stored as a double to account for half bathrooms. Examples: 1 1.5 2	number
bedrooms	The number of bedrooms in the property.	integer
constructions	Accepts a string array.	Array[string]
creationDate	The date _ was created.	string
facts	Accepts a string array.	Array[string]
features	An array of features that the property contains. For example, to search for waterfront property with a wraparound porch, enter an array containing keywords of the features. Example: ["waterfront", "wraparound porch"]	Array[string]
finishedSqFt	The area of the property, in square feet.	number
forSale	Indicates whether the property is for sale. Default is for sale, or True.	boolean
hoa	Accepts a double value.	number
id	ID of the Property object, stored as an ObjectID.	ObjectId
images	The property images, stored in a JSON object.	object
jsonImages	An array of JsPropertyFieldFile objects containing image data.	Array[JsPropertyFieldFile]
lastSoldDate	The last date on which this property was sold. This field works in tandem with `forSale`, and should be populated if `forSale` is False. Example: January 1, 2000	string
lastSoldPrice	The price at which the property was last sold.	number
links	Relevant links returned with each property.	Array[string]
lotSizeAcre	Property lot size in acres.	number
lotSizeSqFt	Property lot size in square feet.	number
mls	Accepts a string value.	string
modifiedByOverride	String that returns the date it was modified and who it was modified by.	string
numberOfUnit	The number of units in the property. Default value is 1.	integer
price	The price of the unit.	number
priceDate	The date on which the current price was set.	string
propertyDescription	A description of the property.	string
propertyTaxPercent	The property tax for the property, given as a percent out of 100. Example: 3	number
propertyTaxYear	The year on which the current property tax was set. Returns a null string if there is has not been a property tax on this property.	string
propertyType	The type of property. Takes one of the values listed below. Default value is "SingleFamily". Enum Values: SingleFamily Apartment Condominium Townhome Townhouse DetachedCondominium HighRiseCondo SiteCondo ManufacturedHousingDoubleWide ManufacturedHousingSingleWide Cooperative MultiFamily ManufacturedHousing ManufacturedHomeCondominium ManufacturedHousingMultiWide UnitDwelling_2_4	string
taxAssessment	The tax assessment for the property. Returns 0 if there has not been a tax assessment.	number
taxAssessmentYear	The year the property tax assessment was completed. Returns null string if tax assessment was never completed.	string
totalRooms	The total number of rooms in the property.	integer
yearBuilt	The year the property was built.	integer